Commit Convention
Introduction
Using a commit message convention is important because it provides context and clarity about changes made to a codebase. By following a consistent format, team members can quickly understand the purpose and impact of a commit, improving collaboration and communication. Additionally, commit message conventions enable automatic changelogs to be generated, making it easier to track changes and understand the development history of a project.
Why Convention Commits?
Conventional Commits was chosen as our commit convention because it is designed to be human-readable and easy to follow, while still providing enough structure to allow for automated tools to generate changelogs.
Our Standard
Template
type(scope): description
Refs: #task
Example
feat(api): support for custom filters on People Search
Refs: #2353
Types
If a commit is more than one type at the same time, it should be split into different smaller commits.
- fix: when fixing something. Ex: a bug fix.
- feat: when adding a new feature/functionality. Ex: new API endpoint or add a new functionality to a new component
- refactor: a code change that neither fixes a bug nor adds a feature.
- perf: a code change that improves performance.
- style: changes that do not affect the meaning or functionality of the code (white-space, formatting, regions, summaries, etc).
- chore: changes related to version bumps, dependencies or pipelines.
Scopes
- api: back-end changes
- client: front-end changes
- lang: localization changes
- comp: component changes
- int: integration changes
- mig: migration changes
Description
The description is a short summary of the code changes and should be in English in the present tense. Write it as you would explain to an external person what your change does.